home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 2000 #4 / Amiga Plus CD - 2000 - No. 4.iso / Tools / Dev / Bgui / AutoDoc / progressclass.doc < prev    next >
Encoding:
Text File  |  2000-05-09  |  2.4 KB  |  161 lines
  1. TABLE OF CONTENTS
  2.  
  3. progressclass/--background--
  4. progressclass/PROGRESS_Divisor
  5. progressclass/PROGRESS_Done
  6. progressclass/PROGRESS_FormatString
  7. progressclass/PROGRESS_Max
  8. progressclass/PROGRESS_Min
  9. progressclass/PROGRESS_Vertical
  10.  
  11. progressclass/--background--
  12.  
  13. NAME
  14.  
  15.   Class: progressclass
  16.   Superclass: baseclass
  17.   Include File: <libraries/bgui.h>
  18.  
  19. FUNCTION
  20.  
  21.   To provide a progression indicator in the form of a fuel gauge.
  22.   Objects from this class will send out the following attribute pairs in
  23.   notification events:
  24.  
  25.   GA_ID - Gadget object ID.
  26.   PROGRESS_Done - Current level of progression.
  27.  
  28.  
  29. progressclass/PROGRESS_Divisor
  30.  
  31. NAME
  32.  
  33.   PROGRESS_Divisor -- ( ULONG )
  34.  
  35. FUNCTION
  36.  
  37.   Set a divisor which is used to divide the level of progression before
  38.   it is rendered. This is necessary when the progression minimum and
  39.   maximum levels are very far apart (I.E. 0 to 0xFFFFFFFF). This way a
  40.   fairly accurate progression is displayed.
  41.  
  42.  
  43. progressclass/PROGRESS_Done
  44.  
  45. NAME
  46.  
  47.   PROGRESS_Done -- ( LONG )
  48.  
  49. FUNCTION
  50.  
  51.   Set or update the current level of progression.
  52.  
  53. DEFAULT
  54.  
  55.   0.
  56.  
  57. APPLICABILITY
  58.  
  59.   (ISGNU).
  60.  
  61. SEE ALSO
  62.  
  63.   PROGRESS_Min, PROGRESS_Max
  64.  
  65. progressclass/PROGRESS_FormatString
  66.  
  67. NAME
  68.  
  69.   PROGRESS_FormatString -- ( STRPTR )
  70.  
  71. FUNCTION
  72.  
  73.   Set the C-style format string which is used to format the current
  74.   progression. By default this tag is set to NULL which means that no
  75.   textual progression is rendered in the object. When this points to a
  76.   0-terminated C-style format string a textual progression is rendered
  77.   in the object.
  78.  
  79. NOTE:
  80.  
  81.   Since V38 of the library it is possible to use locale's
  82.   FormatString() formatting codes. Locale specific formatting
  83.   codes will only work when the locale.library is available.
  84.  
  85. DEFAULT
  86.  
  87.   NULL.
  88.  
  89. APPLICABILITY
  90.  
  91.   (I).
  92.  
  93. SEE ALSO
  94.  
  95.   exec.library/RawDoFmt(), PROGRESS_Done
  96.  
  97. progressclass/PROGRESS_Max
  98.  
  99. NAME
  100.  
  101.   PROGRESS_Max - ( LONG )
  102.  
  103. FUNCTION
  104.  
  105.   Set maximum possible progression.
  106.  
  107. DEFAULTS
  108.  
  109.   100.
  110.  
  111. APPLICABILITY
  112.  
  113.   (IS).
  114.  
  115. SEE ALSO
  116.  
  117.   PROGRESS_Min, PROGRESS_Done
  118.  
  119. progressclass/PROGRESS_Min
  120.  
  121. NAME
  122.  
  123.   PROGRESS_Min - ( LONG )
  124.  
  125. FUNCTION
  126.  
  127.   Set the minimum possible progression.
  128.  
  129. DEFAULT
  130.  
  131.   0.
  132.  
  133. APPLICABILITY
  134.  
  135.   (IS).
  136.  
  137. SEE ALSO
  138.  
  139.   PROGRESS_Max, PROGRESS_Done
  140.  
  141. progressclass/PROGRESS_Vertical
  142.  
  143. NAME
  144.  
  145.   PROGRESS_Vertical -- ( BOOL )
  146.  
  147. FUNCTION
  148.  
  149.   To make the indication vertical. By default the gauge is horizontal
  150.   which is filled from left to right. A vertical gauge is filled from
  151.   bottom to top.
  152.  
  153. DEFAULT
  154.  
  155.   FALSE.
  156.  
  157. APPLICABILITY
  158.  
  159.   (I).
  160.  
  161.